title: Git Commit规范
date: 2021-01-07 10:51:37
categories:
Git Commit规范
4. Commit 规范
摘自:https://mini.ant.design/
开发过程中,提交 commit 时,需要遵循以下原则:
- 最小化代码变更:保证每个 commit 的逻辑独立、原子化。一个 commit 只做一件事,哪怕这件事只改了 1 行代码,你也应该独立 commit 这次变更;
- 遵循 Conventional Commits 原则:避免没有意义、看不懂的 Commit Message 引入,并且在代码提交的时候会有 Commit Message 格式校验。一般情况下,你会大量的使用到:
- 使用 feat(scope): xxx 来描述一个 feature 的 commit;
- 使用 fix(scope): xxx 来描述一个 bug fixes 的 commit;
- 使用 chore(scope): xxx 来来描述一个无关 feature 和 bug fixes 的小调整;
- issue:如果改动与 issue 相关,请在 Commit Message 中带上 issue 参数,如:fix(scope): [#1] xxxxxx;
Commitizen, Husky, Commitlint
先简要地介绍这三个工具的作用,让大家对整个校验过程如何实现有一个大体的了解。
- Commitizen:是一个命令行提示工具,它主要用于帮助我们更快地写出规范的commit message
- Commitlint:用于校验填写的commit message是否符合设定的规范
- Husky:是一个git hook工具,用于在提交过程中的某个特定时刻触发commitlint